feat: add a browser lib to produce sa11y minified JS bundle #32

mohanraj-r · 2020-08-12T02:56:32Z

Produce a Sa11y minified JS file sa11y.min.js that wraps over axe-core library
sa11y.min.js would be injected into the browser, from webdriver tests e.g., instead of axe-core JS library to provide the same set of Sa11y APIs across different testing workflows
sa11y.min.js would still expose the axe-core library same as axe.min.js so the existing APIs relying on axe.min.js would continue to work without having to rewrite everything to make use of the Sa11y APIs
A followup-PR will add functionality to add selected functionality from the Sa11y library (e.g. a11y results filtering) to the sa11y.min.js

TODO

Update sa11y_dependency_graph.svg to reflect changes in this PR
Bump versions, Update changelog

Post merge

Publish github release
- Skip npm release for this PR. Have a axe v4 upgrade PR that needs to be released next.

# Conflicts: # package.json

# Conflicts: # package.json # yarn.lock

based on https://github.com/salesforce/lwc

based on recommendations from https://tools.ietf.org/id/draft-knodel-terminology-00.html

https://webdriver.io/docs/gettingstarted.html

https://webdriver.io/docs/typescript.html

that has been moved to wdio

use explicit sa11y version for checking

minor doc fixes

mohanraj-r · 2020-08-12T21:45:20Z

packages/browser-lib/README.md

@@ -0,0 +1,28 @@
+# `@sa11y/browser-lib`


Not sure if browser-lib is an apt name for the library that produces sa11y.min.js.
Suggestions welcome!

due to cicleci perm errors related to third party codecov orb

codecov · 2020-08-14T21:11:31Z

Codecov Report

❗ No coverage uploaded for pull request base (master@81c09be). Click here to learn what that means.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             master       #32   +/-   ##
==========================================
  Coverage          ?   100.00%           
==========================================
  Files             ?        14           
  Lines             ?       112           
  Branches          ?        11           
==========================================
  Hits              ?       112           
  Misses            ?         0           
  Partials          ?         0

add default config file

trevor-bliss · 2020-08-18T00:33:06Z

packages/browser-lib/README.md

+
+Provides a minified version of selected `@sa11y` libraries to be injected into a browser (using webdriver) and executed from integration testing workflows. This allows for reuse of the `@sa11y` libraries across unit and integration testing workflows.
+
+Code in this package should be limited only to wrappers required to facilitate execution in browser environment. All primary code should be added to `@sa11y` libraries.


I'm a little unclear when you would use this package vs. the wdio package. I see the example usage below looks like it's even wdio sample code.

It is to be used in testing workflows without webdriverIO e.g. Java. Added clarification to doc. Please let me know if that answers your question.

Ok got it. That makes sense, but I still find it a little confusing that the sample below is in Javascript if the main target is Java. It'd be nice to see a more complete example authored in Java, even if the test cases in this project are still Javascript.

If I was a consumer trying to integrate this into my Java test suite, it would take some exploration still to figure out how exactly to use it.

Agree, was thinking the same. Added Java example.

trevor-bliss · 2020-08-18T16:54:57Z

package.json

@@ -17,8 +17,9 @@
    ],
    "scripts": {
        "build": "tsc --build",
-        "build:ci": "yarn install --frozen-lockfile && yarn build",
-        "build:clean": "yarn build --clean && rimraf packages/**/dist && yarn install && yarn build",
+        "build:minjs": "yarn workspace @sa11y/browser-lib build",


I would expect this to run during the normal build, instead of only build:ci.

Makes sense. Fixed. Was trying to hold on to tsc --build being used only once and reusing yarn build.

trevor-bliss · 2020-08-18T16:57:31Z

packages/browser-lib/rollup.config.js

+        resolve(),
+        commonjs(),
+        typescript({ tsconfigOverride: { compilerOptions: { module: 'es2015' } } }),
+        terser(), // Note: Comment to get un-minified file for debugging etc


You could also produce an un-minified sa11y.js in addition to the minified sa11y.min.js. Then the consumer would choose which version they wanted to use.

trevor-bliss · 2020-08-18T17:06:10Z

packages/browser-lib/src/index.ts

+export { sortViolations } from '@sa11y/format';
+export { assertAccessible } from '@sa11y/assert';
+
+export const nameSpace = 'sa11y';


This is usually "namespace" (all lowercase).

trevor-bliss · 2020-08-18T17:22:38Z

packages/browser-lib/README.md

+
+Provides a minified version of selected `@sa11y` libraries to be injected into a browser (using webdriver) and executed from integration testing workflows. This allows for reuse of the `@sa11y` libraries across unit and integration testing workflows.
+
+Code in this package should be limited only to wrappers required to facilitate execution in browser environment. All primary code should be added to `@sa11y` libraries.


Ok got it. That makes sense, but I still find it a little confusing that the sample below is in Javascript if the main target is Java. It'd be nice to see a more complete example authored in Java, even if the test cases in this project are still Javascript.

If I was a consumer trying to integrate this into my Java test suite, it would take some exploration still to figure out how exactly to use it.

mohanraj-r

Thanks for the review @trevor-bliss
Addressed your comments. Please review.

Mohan Raj Rajamanickam added 30 commits June 2, 2020 20:37

build(deps): add semantic release deps

474aa7d

build(release): add semanic release config

b26f5fc

build: add cmds to list packages and its deps

c9f98f2

build(deps): add cmds for versioning, publishing, dep check

bfd79e4

build: add cmds to list packages and its deps

a0d8737

# Conflicts: # package.json

build: fix dep check cmd, add lint:deps cmd

805210a

fix(deps): add missing dependencies in package json

066522a

chore(release): bump versions

922af5d

build: fix dep check cmd

cef8a48

build: add deps, config for semantic release github plugin

521a197

build: add git hook to run yarn install when switching branches

66ad552

build: change release cmd, config in prep for merge to release branch

dd2bb29

docs(changelog): remove obsolete links, add PR links, cleanup

07fd558

Merge branch 'release-semantic' into release

03d2888

# Conflicts: # package.json # yarn.lock

build: add test debug script and update corresponding docs

384f46c

based on https://github.com/salesforce/lwc

docs(contributing): add notes on release process

219f2c2

chore: update yarn lockfile

c6cc630

docs(contributing): clarify about when to use release branch

a58303e

docs(jest): updates to readme for clarity

20b209f

docs(jest): add clarification on recommended ruleset

36241e3

test(cspell): add flagwords

293fa02

based on recommendations from https://tools.ietf.org/id/draft-knodel-terminology-00.html

test(integ): add integ test to inject axe using wdio

b4e9a64

docs(contrib): add note about yarn installing when changing branches

b897c2c

build(wdio): add scafolding for wdio package

ef565c8

build(wdio): add dev deps for wdio using wdio cli

7fe2de6

https://webdriver.io/docs/gettingstarted.html

build(wdio): add pkgs,config for wdio typescript integration

2fd6e4e

https://webdriver.io/docs/typescript.html

test(wdio): add tests to inject axe using wdio

95d5549

feat(wdio): add assert accessible API for WDIO

23e50ae

test(wdio): add tests using the wdio assert API

ee0b97a

revert(wdio): revert obsolete code in integ tests package

6db20b4

that has been moved to wdio

mohanraj-r added 5 commits August 12, 2020 13:49

test(browser-lib): refactor to remove redundant async

d47ddf8

use explicit sa11y version for checking

docs(browser-lib): add example illustrating usage

cb50d6c

minor doc fixes

refactor(browser-lib): reuse namespace in rollup config

d607d41

test(wdio): add support for debug flag

6f052e6

build: update dependencies, changelog, version

a8420ec

mohanraj-r commented Aug 12, 2020

View reviewed changes

mohanraj-r requested review from trevor-bliss and a team August 12, 2020 21:47

mohanraj-r marked this pull request as ready for review August 12, 2020 21:47

mohanraj-r self-assigned this Aug 13, 2020

mohanraj-r added 3 commits August 14, 2020 12:35

ci: add code coverage config

4778508

ci: add codecov badge to readme

bfa6617

ci: use codecov npm pkg instead of circleci orb

a6e8c2b

due to cicleci perm errors related to third party codecov orb

mohanraj-r added 3 commits August 17, 2020 11:46

ci: add CodeQL analysis by github

301e2fc

add default config file

build: update deps - rollup, eslint

be9d002

ci: remove obsolete github workflow configs

773a678

trevor-bliss reviewed Aug 18, 2020

View reviewed changes

docs: add clarification on browser lib usage

a17818d

trevor-bliss reviewed Aug 18, 2020

View reviewed changes

mohanraj-r added 5 commits August 18, 2020 13:42

refactor(browserlib): remove camelcase in nameSpace

2de8aa4

build(browserlib): add un-minified output in addition to minified bundle

1f90e84

build: refactor build cmd to include minified bundle build

40fc225

docs(browserlib): add Java example to illustrate usage

acce56d

build(browserlib): add a debug flag to build cmd

ccec14f

mohanraj-r commented Aug 18, 2020

View reviewed changes

trevor-bliss approved these changes Aug 19, 2020

View reviewed changes

mohanraj-r merged commit 8a44543 into salesforce:master Aug 19, 2020

mohanraj-r deleted the add_browser_lib branch August 19, 2020 20:04

mohanraj-r mentioned this pull request Aug 19, 2020

chore: update to axe v4 #33

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add a browser lib to produce sa11y minified JS bundle #32

feat: add a browser lib to produce sa11y minified JS bundle #32

mohanraj-r commented Aug 12, 2020 •

edited

Loading

mohanraj-r Aug 12, 2020

codecov bot commented Aug 14, 2020

trevor-bliss Aug 18, 2020

mohanraj-r Aug 18, 2020

trevor-bliss Aug 18, 2020

mohanraj-r Aug 18, 2020

trevor-bliss Aug 18, 2020

mohanraj-r Aug 18, 2020

trevor-bliss Aug 18, 2020

mohanraj-r Aug 18, 2020

trevor-bliss Aug 18, 2020

mohanraj-r Aug 18, 2020

trevor-bliss Aug 18, 2020

mohanraj-r left a comment


		Provides a minified version of selected `@sa11y` libraries to be injected into a browser (using webdriver) and executed from integration testing workflows. This allows for reuse of the `@sa11y` libraries across unit and integration testing workflows.

		Code in this package should be limited only to wrappers required to facilitate execution in browser environment. All primary code should be added to `@sa11y` libraries.

feat: add a browser lib to produce sa11y minified JS bundle #32

feat: add a browser lib to produce sa11y minified JS bundle #32

Conversation

mohanraj-r commented Aug 12, 2020 • edited Loading

TODO

Post merge

Choose a reason for hiding this comment

codecov bot commented Aug 14, 2020

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mohanraj-r left a comment

Choose a reason for hiding this comment

mohanraj-r commented Aug 12, 2020 •

edited

Loading